将集成导出到 Platform CLI
Zapier Platform CLI(命令行界面)是一个工具集,您可以在本地开发环境中安装并运行。它让您能够通过 JavaScript 代码和终端命令来构建、测试和管理您的 Zapier 集成。
Platform UI 适合那些有 API 经验且更偏好使用视觉表单编辑器的用户来构建 Zapier 集成。
另一方面,CLI 是专业开发者和团队的最强大工具。其中一些优势包括:
- 访问 Zapier Platform 的所有功能
- 更好地优化您的代码:将共享逻辑移入模块,并利用中间件来集中处理请求和响应。
- 更轻松的团队协作:您可以将 Zapier 集成的所有代码提交到团队的源代码仓库中。
- 设置自动回归测试,以便每次推送更改时都能捕获错误。
要将您现有的 Platform UI 集成导出到 Platform CLI,请按照以下步骤操作:
1. 在开发环境中安装并配置 Zapier CLI
请按照快速入门指南中的设置部分步骤进行操作。
2. 运行 convert
命令,以在本地创建 CLI 版本的项目
为您的 Zapier 项目创建一个新目录,然后在命令行中使用 cd
进入该目录。随后运行以下命令:
zapier convert {your integration id} . --version={integration version you want to convert}
您的集成 ID 可以在 Platform UI 中的浏览器地址栏中找到:
同样,您的版本也可以在那里以及 Platform UI 的其他地方找到:
以此为例,要在当前目录中创建项目,命令为:
zapier convert 1234 . --version=1.0.0
3. 探索您的新 CLI 项目并熟悉该工具
请查看文档的CLI 部分中可用的资源,以全面了解 Zapier CLI。
如果您需要复习 JavaScript,建议花时间查看在线的众多优秀资源。Zapier Platform 广泛使用 promises,因此这是您应该熟悉的重要 JavaScript 主题。
4. 部署
运行 convert
命令并创建新的本地 CLI 项目后,它会自动与您的 Zapier 集成关联(通过 .zapierapprc
文件)。
部署前,请注意以下几点:
- 将 CLI 项目推送到服务器时,会创建一个_新版本_的您的集成。如果您还不熟悉版本机制,可以先在此处了解一下。
- 查看
package.json
文件中的版本号。使用convert
工具创建项目时,我们会自动递增转换的版本号。您可以根据需要更改版本号,但请确保该版本号在您的集成中尚未存在。从项目目录运行zapier versions
命令来查看现有版本。 - 使用
zapier convert
命令转换的集成会在package.json
中包含convertedByCLIVersion
,以供参考。
准备好后,运行以下命令部署 CLI 版本:
zapier push
部署完成后,您可以在 Platform UI 的“管理 > 版本”部分看到新版本,并使用这个基于 CLI 构建的版本创建 Zap。
您无法从 Platform UI 的“构建”部分编辑这个新 CLI 构建的版本,该版本的属性将显示锁定图标。
不过,您仍然可以使用 Platform UI 的其他功能,包括版本管理、嵌入管理和合作伙伴仪表板。您之前的版本(在 Platform UI 中创建的)也依然可用,可继续编辑和使用。
如果您决定不使用 Platform CLI,可以从“管理 > 版本”中删除新版本,然后继续在 Platform UI 中操作。